home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 February / EnigmA AMIGA RUN 15 (1997)(G.R. Edizioni)(IT)[!][issue 1997-02][PLANET CD V].iso / progs / editor / frexxed / bin / etags.lha / etags.man < prev    next >
Text File  |  1995-01-27  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. etags(1)                    GNU Tools                    etags(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      etags -- generate tag file for Emacs
  10.      ctags -- generate tag file for vi
  11.  
  12. SYNOPSIS
  13.      etags [-CDSTVHadt] [-i file] [-o outfile]
  14.      [--defines] [--no-defines] [--c++] [--typedefs]
  15.      [--typedefs-and-c++] [--ignore-indentation]
  16.      [--help] [--version]
  17.      [--include=file] [--output=outfile] [--append] file ...
  18.  
  19.      ctags [-CDSTVHadt] [-BFuvwx] [-o outfile]
  20.      [--defines] [--no-defines] [--c++] [--typedefs]
  21.      [--typedefs-and-c++] [--ignore-indentation] [--no-warn]
  22.      [--backward-search] [--forward-search] [--vgrind] [--cxref]
  23.      [--help] [--version]
  24.      [--output=outfile] [--append] [--update] file ...
  25.  
  26. DESCRIPTION
  27.      The `etags' program is used to create a tag table file, in a
  28.      format  understood  by emacs(1); the `ctags' program is used
  29.      to create a similar table in a format understood  by  vi(1).
  30.      Both  forms  of the program understand the syntax of C, For-
  31.      tran, LaTeX, Scheme and Emacs Lisp/Common Lisp.  Both  forms
  32.      read  the  files  specified on the command line, and write a
  33.      tag table (defaults: `TAGS' for etags, `tags' for ctags)  in
  34.      the  current  working  directory. The programs recognize the
  35.      language used in an input file based on its  file  name  and
  36.      contents; there are no switches for specifying the language.
  37.  
  38. OPTIONS
  39.      Some options make sense only for vi style tag  files;  etags
  40.      does  not  recognize  them.  The programs accept unambiguous
  41.      abbreviations for long option names.
  42.  
  43.      -d, --defines
  44.           Create tag entries for C preprocessor definitions, too.
  45.           This is the default behavior for -Betags.
  46.  
  47.      -D, --no-defines
  48.           Do not create tag entries for  C  preprocessor  defini-
  49.           tions.  This is the default behavior for -Bctags.
  50.  
  51.      -C, --c++
  52.           Treat files with `.c' and `.h' extensions as C++  code,
  53.           not  C code.  Files with `.C', `.H', `.cxx', `.hxx', or
  54.           `.cc' extensions are always assumed to be C++ code.
  55.  
  56.      -t, --typedefs
  57.           Record typedefs in C code as tags.
  58.  
  59.      -T, --typedefs-and-c++
  60.  
  61.  
  62.  
  63. GNU Tools            Last change: 10feb1992                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. etags(1)                    GNU Tools                    etags(1)
  71.  
  72.  
  73.  
  74.           Generate tag entries for typedefs,  struct,  enum,  and
  75.           union tags, and C++ member functions.
  76.  
  77.      -S, --ignore-indentation
  78.           Don't rely on indentation as much as  we  normally  do.
  79.           Currently,  this  means  not  to  assume that a closing
  80.           brace in the first column is the final brace of a func-
  81.           tion or structure definition.
  82.  
  83.      -w, --no-warn
  84.           Suppress warning messages about duplicate entries.  The
  85.           etags  program does not check for duplicate entries, so
  86.           this option has no effect on it.
  87.  
  88.      -B, --backward-search
  89.           Tag files written in the format expected by vi  contain
  90.           regular  expression  search instructions; the -B option
  91.           writes them using the delimiter `?',  to  search  back-
  92.           wards through files.  Only ctags accepts this option.
  93.  
  94.      -F, --forward-search
  95.           Tag files written in the format expected by vi  contain
  96.           regular  expression  search instructions; the -F option
  97.           writes them using the delimiter `/', to search forwards
  98.           through  files.   Only ctags accepts this option; it is
  99.           the default behavior.
  100.  
  101.      -v, --vgrind
  102.           Instead of generating  a  tag  file,  write  index  (in
  103.           vgrind  format) to standard output.  Only ctags accepts
  104.           this option.
  105.  
  106.      -x, --cxref
  107.           Instead of generating a tag file, write a cross  refer-
  108.           ence  (in cxref format) to standard output.  Only ctags
  109.           accepts this option.
  110.  
  111.      -H, --help
  112.           Print usage information.
  113.  
  114.      -V, --version
  115.           Print the current version of the program.
  116.  
  117.      -i file, --include=file
  118.           Include a  note  in  tag  file  indicating  that,  when
  119.           searching  for  a tag, one should also consult the tags
  120.           file file after checking the current file.  Only  etags
  121.           accepts this option.
  122.  
  123.      -o outfile, --output=outfile
  124.           Explicit name of file for tag table; overrides  default
  125.           `TAGS' or `tags'.   (But ignored with -v or -x.)
  126.  
  127.  
  128.  
  129. GNU Tools            Last change: 10feb1992                     2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. etags(1)                    GNU Tools                    etags(1)
  137.  
  138.  
  139.  
  140.      -a, --append
  141.           Append to existing tag file.  (For vi-format tag files,
  142.           see also --update.)
  143.  
  144.      -u, --update
  145.           Update tag entries for files specified on command line,
  146.           leaving tag entries for other files in place.  Current-
  147.           ly, this is implemented by deleting  the  existing  en-
  148.           tries  for  the  given files and then rewriting the new
  149.           entries at the end of the tags file.  It is often  fas-
  150.           ter  to  simply rebuild the entire tag file than to use
  151.           this.  (Implies vi-format tag file.)
  152.  
  153.  
  154. SEE ALSO
  155.      `emacs' entry in info; GNU Emacs Manual, Richard Stallman.
  156.      cxref(1), emacs(1), vgrind(1), vi(1).
  157.  
  158.  
  159. COPYING
  160.      Copyright (c) 1992 Free Software Foundation, Inc.
  161.  
  162.      Permission is granted to make and distribute verbatim copies
  163.      of  this  manual provided the copyright notice and this per-
  164.      mission notice are preserved on all copies.
  165.  
  166.      Permission is granted to copy and distribute  modified  ver-
  167.      sions of this manual under the conditions for verbatim copy-
  168.      ing, provided that the entire resulting derived work is dis-
  169.      tributed under the terms of a permission notice identical to
  170.      this one.
  171.  
  172.      Permission is granted to copy and distribute translations of
  173.      this  manual  into  another language, under the above condi-
  174.      tions for modified versions, except that this permission no-
  175.      tice  may  be  included in translations approved by the Free
  176.      Software Foundation instead of in the original English.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. GNU Tools            Last change: 10feb1992                     3
  196.  
  197.  
  198.  
  199.